<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>EJAM/EJSCREEN comparisons - see summary stats after using ejscreen_vs_ejam() — ejscreen_vs_ejam_summary • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="EJAM/EJSCREEN comparisons - see summary stats after using ejscreen_vs_ejam() — ejscreen_vs_ejam_summary"><meta name="description" content="EJAM/EJSCREEN comparisons - see summary stats after using ejscreen_vs_ejam()"><meta property="og:description" content="EJAM/EJSCREEN comparisons - see summary stats after using ejscreen_vs_ejam()"><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/USEPA/EJAM/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>EJAM/EJSCREEN comparisons - see summary stats after using ejscreen_vs_ejam()</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/ejscreen_vs_ejam_.R" class="external-link"><code>R/ejscreen_vs_ejam_.R</code></a></small>
      <div class="d-none name"><code>ejscreen_vs_ejam_summary.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>EJAM/EJSCREEN comparisons - see summary stats after using ejscreen_vs_ejam()</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">ejscreen_vs_ejam_summary</span><span class="op">(</span></span>
<span>  vs <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  myvars <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/colnames.html" class="external-link">colnames</a></span><span class="op">(</span><span class="va">vs</span><span class="op">$</span><span class="va">EJAM</span><span class="op">)</span>,</span>
<span>  tol <span class="op">=</span> <span class="fl">0.05</span>,</span>
<span>  prob <span class="op">=</span> <span class="fl">0.95</span>,</span>
<span>  na.rm <span class="op">=</span> <span class="cn">TRUE</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-vs">vs<a class="anchor" aria-label="anchor" href="#arg-vs"></a></dt>
<dd><p>output of ejscreen_vs_ejam()</p></dd>


<dt id="arg-myvars">myvars<a class="anchor" aria-label="anchor" href="#arg-myvars"></a></dt>
<dd><p>optional to check just a subset of the colnames found in vs$EJAM and vs$EJSCREEN,
such as these possible values:</p>
<p>myvars = "all"    # all the indicators in the output tables, i.e., colnames(vs$EJAM)</p>
<p>myvars = "inboth" # just the ones in both (not NA values because EJAM or EJSCREEN did not report the indicator)</p>
<p>myvars = "bad"    # just the ones in both where EJAM_shown and EJSCREEN_shown disagree</p>
<p>myvars = c(names_d, names_d_subgroups) or</p>
<p>myvars = grep("pctile", colnames(vs$EJAM), value = T)</p></dd>


<dt id="arg-tol">tol<a class="anchor" aria-label="anchor" href="#arg-tol"></a></dt>
<dd><p>optional, set this so that results can be said to agree with this tolerance
if they differ by less than tol percent where tol is expressed as a fraction 0 to 1.</p></dd>


<dt id="arg-prob">prob<a class="anchor" aria-label="anchor" href="#arg-prob"></a></dt>
<dd><p>optional fraction of 1 representing percentile p to check for absolute percentage differences.
See within.x.pct.at.p.pct.of.sites value that is returned.</p></dd>


<dt id="arg-na-rm">na.rm<a class="anchor" aria-label="anchor" href="#arg-na-rm"></a></dt>
<dd><p>needs testing, optional</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>A data.frame of summary stats showing counts and percents of analyzed sites (or those with valid data
that are found in both EJAM and EJSCREEN outputs), indicating how many of the sites
agree between EJSCREEN and EJAM estimates, exactly as reported or within some tolerance.
Columns include</p>
<p>"indicator" (variable name)</p>
<p>"sites.with.data.ejam" How many of the sites had a value from EJAM for the given indicator?</p>
<p>"sites.with.data.neither" How many sites had NA from both EJAM and EJSCREEN?</p>
<p>"sites.with.data.both"</p>
<p>"sites.agree.rounded" How many sites agree (EJSCREEN vs EJAM) in the value shown on reports?
i.e., the reported, rounded value.</p>
<p>"sites.agree.within.tol" How many sites agree within tol? (i.e., with tol x 100 percent)</p>
<p>"pct.of.sites.agree.rounded"  as a percent 0-100% of sites with data</p>
<p>"pct.of.sites.agree.within.tol"  as a percent 0-100% of sites with data</p>
<p>"median.abs.diff" Median over sites with data, of the absolute differences, EJAM - EJSCREEN</p>
<p>"max.abs.diff"</p>
<p>"mean.pct.diff" Percent difference 0-100% is absolute value of 100*(ratio - 1), and ratio is EJAM/EJSCREEN</p>
<p>"median.pct.diff" 0-100%</p>
<p>"max.pct.diff" 0-100%</p>
<p>"within.x.pct.at.p.pct.of.sites"  X, where EJAM and EJSCREEN agree within X percent 0-100% or better
at prob share of sites. Prob share as used in this last stat should mean prob (e.g. 0.95) share of sites have
an absolute percentage difference in estimated indicator values that is less than or equal to x
where x is one of the actual values of abspctdiff found * 100.
It uses 100 * quantile(y, probs = prob, type = 1)</p>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span>  <span class="va">radius</span> <span class="op">=</span> <span class="fl">3</span></span>
<span>  <span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span> <span class="co"># \dontrun{</span></span>
<span>  <span class="va">pts</span> <span class="op">&lt;-</span> <span class="fu"><a href="testpoints_n.html">testpoints_n</a></span><span class="op">(</span><span class="fl">100</span>, weighting <span class="op">=</span> <span class="st">'frs'</span><span class="op">)</span></span>
<span>  </span>
<span>  <span class="co"># This step can take a long time, almost 1 minute per 20 points, as it uses the EJScreen API:</span></span>
<span>  <span class="va">vs100</span> <span class="op">&lt;-</span> <span class="fu"><a href="ejscreen_vs_ejam.html">ejscreen_vs_ejam</a></span><span class="op">(</span><span class="va">pts</span>, radius <span class="op">=</span> <span class="va">radius</span>, include_ejindexes <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
<span>  </span>
<span>  <span class="fu"><a href="ejscreen_vs_ejam_see1.html">ejscreen_vs_ejam_see1</a></span><span class="op">(</span><span class="va">vs100</span>, mysite <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span>
<span>  </span>
<span>  <span class="co"># see site with largest % disagreement:</span></span>
<span>  <span class="fu"><a href="ejscreen_vs_ejam_see1.html">ejscreen_vs_ejam_see1</a></span><span class="op">(</span><span class="va">vs</span>, <span class="st">'pop'</span>, mysite <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/which.min.html" class="external-link">which.max</a></span><span class="op">(</span><span class="va">vs</span><span class="op">$</span><span class="va">abspctdiff</span><span class="op">$</span><span class="va">pop</span><span class="op">)</span><span class="op">)</span></span>
<span>  </span>
<span>  <span class="va">vs100</span><span class="op">$</span><span class="va">diff</span><span class="op">$</span><span class="va">blockcount_near_site</span></span>
<span>  <span class="va">sum100</span> <span class="op">&lt;-</span> <span class="fu">ejscreen_vs_ejam_summary</span><span class="op">(</span><span class="va">vs100</span>, tol <span class="op">=</span> <span class="fl">0.01</span><span class="op">)</span></span>
<span>  <span class="va">s100</span> <span class="op">&lt;-</span> <span class="va">sum100</span><span class="op">[</span> , <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">1</span>, <span class="fl">6</span><span class="op">:</span><span class="fl">12</span><span class="op">)</span><span class="op">]</span></span>
<span>  </span>
<span>  <span class="va">s100</span><span class="op">[</span><span class="va">s100</span><span class="op">$</span><span class="va">indicator</span> <span class="op"><a href="https://rdrr.io/r/base/match.html" class="external-link">%in%</a></span> <span class="va">names_e</span>, <span class="op">]</span></span>
<span>  <span class="va">s100</span><span class="op">[</span><span class="va">s100</span><span class="op">$</span><span class="va">indicator</span> <span class="op"><a href="https://rdrr.io/r/base/match.html" class="external-link">%in%</a></span> <span class="va">names_d</span>, <span class="op">]</span></span>
<span>  <span class="va">s100</span><span class="op">[</span><span class="va">s100</span><span class="op">$</span><span class="va">indicator</span> <span class="op"><a href="https://rdrr.io/r/base/match.html" class="external-link">%in%</a></span> <span class="va">names_these</span>, <span class="op">]</span></span>
<span>  <span class="va">s100</span><span class="op">[</span><span class="va">s100</span><span class="op">$</span><span class="va">indicator</span> <span class="op"><a href="https://rdrr.io/r/base/match.html" class="external-link">%in%</a></span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="va">names_ej_pctile</span>, <span class="va">names_ej_state_pctile</span>, <span class="va">names_ej_supp_pctile</span>, <span class="va">names_ej_supp_state_pctile</span><span class="op">)</span>, <span class="op">]</span></span>
<span>  </span>
<span>  <span class="va">sum100_within5pct</span> <span class="op">&lt;-</span> <span class="fu">ejscreen_vs_ejam_summary</span><span class="op">(</span><span class="va">vs100</span>, tol <span class="op">=</span> <span class="fl">0.05</span><span class="op">)</span></span>
<span>  <span class="va">sum100_within5pct</span><span class="op">[</span><span class="va">sum100_within5pct</span><span class="op">$</span><span class="va">indicator</span> <span class="op"><a href="https://rdrr.io/r/base/match.html" class="external-link">%in%</a></span> <span class="va">names_these</span>, <span class="op">]</span><span class="op">[</span> , <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">1</span>, <span class="fl">6</span><span class="op">:</span><span class="fl">12</span><span class="op">)</span><span class="op">]</span></span>
<span>  </span>
<span>  <span class="co">## longer analysis (45 minutes perhaps)</span></span>
<span>  <span class="co"># This step can take a long time, almost 1 minute per 20 points, as it uses the EJScreen API:</span></span>
<span>  <span class="co"># pts &lt;- testpoints_n(1000, weighting = 'frs')</span></span>
<span>  <span class="co"># vs1000pts3miles &lt;- ejscreen_vs_ejam(pts, radius = 3, include_ejindexes = TRUE)</span></span>
<span>  <span class="co"># sum_vs1000pts3miles &lt;- ejscreen_vs_ejam_summary(vs1000pts3miles)</span></span>
<span>  </span>
<span>  <span class="op">}</span> <span class="co"># }</span></span>
<span></span></code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2024</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

